Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[develop]: Documentation updates #2463

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

gspetro-NOAA
Copy link
Contributor

@gspetro-NOAA gspetro-NOAA commented Oct 10, 2024

Description:

This PR updates to the Input/Output chapter of the documentation to include info on fd_ufs.yaml and to update the land-related sections.
This PR also generates documentation from the docstrings in the tests-dev Python scripts.
You can view the docs in my fork here: https://gsp-wm.readthedocs.io/en/text-landda/

Commit Message:

* UFSWM - 
  Update LND I/O docs
  Add fd_ufs.yaml docs
  Add tests-dev docs

Priority:

  • High: Hoping to get changes in ahead of Land DA v2.0.0 release

Git Tracking

UFSWM:

Sub component Pull Requests:

  • None

UFSWM Blocking Dependencies:

  • None

Changes

Regression Test Changes (Please commit test_changes.list):

  • No Baseline Changes.

Input data Changes:

  • None.

Library Changes/Upgrades:

  • No Updates

Testing Log:

  • RDHPCS
    • Hera
    • Orion
    • Hercules
    • Jet
    • Gaea
    • Derecho
  • WCOSS2
    • Dogwood/Cactus
    • Acorn
  • CI
  • opnReqTest (complete task if unnecessary)

@gspetro-NOAA
Copy link
Contributor Author

gspetro-NOAA commented Oct 11, 2024

Note that I have toggled on the functionality to build docs for every PR.
If you click on "Details" after the docs/readthedocs.org:ufs-weather-model check at the bottom of the PR, you will either see the PR docs, the build progress (if it hasn't completed), or the traceback (if it fails). I believe that after 90 days, the build is deleted, so the docs are not stored indefinitely, but this will ensure that there are no obvious issues with the PR docs.

It is possible to turn on a "warn as error" functionality in the docs that will fail the build check when warnings appear (rather than just failing for errors). Let me know if you'd like me to turn on this functionality. It has the benefit of catching small issues as they occur (such as changes to URLs in the docs), which is helpful for maintenance. However, developers may not like having to fix issues like this that are outside their PR scope, even if they are usually small/simple fixes. That said, I'm happy to work with them to put the fixes into their PR or a subsequent PR if such issues occur.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update WM Documentation
1 participant